FindCellTagObject Method, SftTree Class


	FindCellTagObject Method, SftTree Class	Softel vdm, Inc.

Searches the TagObjects property of cells for an object.

Syntax SftTree Class (Softelvdm.SftTreeNET)

VB	Public Function FindCellTagObject( _ ByVal Data As Object, _ ByVal Wrap As Boolean, _ ByVal StartItem As ItemClass, _ ByVal ColumnIndex As Integer, _ ByVal DepthScan As Boolean, _ ByVal VisibleOnly As Boolean _ ) As CellClass
C#	public CellClass FindCellTagObject( object Data, bool Wrap, ItemClass StartItem, int ColumnIndex, bool DepthScan, bool VisibleOnly );
C++	public: CellClass^ FindCellTagObject( Object^ Data, bool Wrap, ItemClass^ StartItem, int ColumnIndex, bool DepthScan, bool VisibleOnly );

ColumnIndex

The zero-based column index of the column to be searched. Only one column can be searched.

Data

Defines the object to find.

DepthScan

Defines whether all items (including dependent items, starting with the starting item StartItem) are searched (True), otherwise False and only sibling items of the starting item (StartItem) are searched.

StartItem

Defines the item where the search starts (including).

VisibleOnly

Defines whether only visible items are searched (True), otherwise False and all items (even items whose parents are collapsed) are searched.

Wrap

Defines whether the search wraps around at the end of the items and resumes at the first item (True), otherwise False.

Return Value

The cell where the first match is found or null/Nothing if no match was found.

Comments

The FindCellTagObject method searches the TagObjects property of cells for an object.

The FindCellTagObject method searches all cells in column ColumnIndex, starting at the item defined by StartItem for the object (Data) in each cell's CellBaseClass.TagObjects property.

The FindItemTagObject, FindItemTagString, FindCellTagString methods perform similar function to search items' and cells' TagObjects and TagString properties. The FindText property searches for a matching string in the CellBaseClass.Text property.